| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

Static Public Member Functions | List of all members
nkAstraeus::ComplexEffectTypeUtils Class Referencefinal

Offers utility functions to help with the enumeration support. More...

## Static Public Member Functions
static nkMemory::StringView | enumToString (COMPLEX_EFFECT_TYPE value)
static COMPLEX_EFFECT_TYPE | stringToEnum (nkMemory::StringView value)

## Detailed Description

Offers utility functions to help with the enumeration support.

## Member Function Documentation

## ◆ enumToString()

static nkMemory::StringView nkAstraeus::ComplexEffectTypeUtils::enumToString | ( | COMPLEX_EFFECT_TYPE | value | ) |
| static

Translates an enum value to a string. Values supported are :

Enum value | String value
--- | ---
COMPLEX_EFFECT_TYPE::UNKNOWN | 'UNKNOWN'
COMPLEX_EFFECT_TYPE::BLUR | 'BLUR'
COMPLEX_EFFECT_TYPE::DOF | 'DOF'

Parameters

  value | The enumeration value to convert.

Returns
  The enumeration value name as a string.

## ◆ stringToEnum()

static COMPLEX_EFFECT_TYPE nkAstraeus::ComplexEffectTypeUtils::stringToEnum | ( | nkMemory::StringView | value | ) |
| static

Translates a string to its enum value.

String value | Enum value
--- | ---
'BLUR' | COMPLEX_EFFECT_TYPE::BLUR
'DOF' | COMPLEX_EFFECT_TYPE::DOF
'UNKNOWN' / Anything else | COMPLEX_EFFECT_TYPE::UNKNOWN'

Parameters

  value | The string to convert.

Returns
  The enumeration value identified.

The documentation for this class was generated from the following file:

- Documentation/Headers/NilkinsAstraeus/Graphics/ComplexEffects/ComplexEffectType.h